# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Filter do
  @moduledoc """
  A filter for a budget, limiting the scope of the cost to calculate.

  ## Attributes

  *   `calendarPeriod` (*type:* `String.t`, *default:* `nil`) - Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.
  *   `creditTypes` (*type:* `list(String.t)`, *default:* `nil`) - Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.
  *   `creditTypesTreatment` (*type:* `String.t`, *default:* `nil`) - Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
  *   `customPeriod` (*type:* `GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1CustomPeriod.t`, *default:* `nil`) - Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.
  *   `labels` (*type:* `map()`, *default:* `nil`) - Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._
  *   `projects` (*type:* `list(String.t)`, *default:* `nil`) - Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on.
  *   `resourceAncestors` (*type:* `list(String.t)`, *default:* `nil`) - Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects.
  *   `services` (*type:* `list(String.t)`, *default:* `nil`) - Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.
  *   `subaccounts` (*type:* `list(String.t)`, *default:* `nil`) - Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :calendarPeriod => String.t() | nil,
          :creditTypes => list(String.t()) | nil,
          :creditTypesTreatment => String.t() | nil,
          :customPeriod =>
            GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1CustomPeriod.t() | nil,
          :labels => map() | nil,
          :projects => list(String.t()) | nil,
          :resourceAncestors => list(String.t()) | nil,
          :services => list(String.t()) | nil,
          :subaccounts => list(String.t()) | nil
        }

  field(:calendarPeriod)
  field(:creditTypes, type: :list)
  field(:creditTypesTreatment)

  field(:customPeriod,
    as: GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1CustomPeriod
  )

  field(:labels, type: :map)
  field(:projects, type: :list)
  field(:resourceAncestors, type: :list)
  field(:services, type: :list)
  field(:subaccounts, type: :list)
end

defimpl Poison.Decoder, for: GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Filter do
  def decode(value, options) do
    GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Filter.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.BillingBudgets.V1.Model.GoogleCloudBillingBudgetsV1Filter do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
